<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>arduino-audio-driver: PinsI2C Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">arduino-audio-driver
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceaudio__driver.html">audio_driver</a></li><li class="navelem"><a class="el" href="structaudio__driver_1_1_pins_i2_c.html">PinsI2C</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structaudio__driver_1_1_pins_i2_c-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PinsI2C Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>I2C pins.  
 <a href="structaudio__driver_1_1_pins_i2_c.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_driver_pins_8h_source.html">DriverPins.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a55ca58ba71e8274ece07c6455513ad8e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__driver_1_1_pins_i2_c.html#a55ca58ba71e8274ece07c6455513ad8e">PinsI2C</a> ()=default</td></tr>
<tr class="separator:a55ca58ba71e8274ece07c6455513ad8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64bff2ba6d0ee2ba3a79ff999af30243"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__driver_1_1_pins_i2_c.html#a64bff2ba6d0ee2ba3a79ff999af30243">PinsI2C</a> (<a class="el" href="group__audio__driver.html#ga6b03ddbf1e0f5abd0e46e02555850aaf">PinFunction</a> <a class="el" href="structaudio__driver_1_1_pins_i2_c.html#ada2a63b4baedf5b15ec9eaf1c575d208">function</a>, <a class="el" href="namespaceaudio__driver.html#a4c343c4d8992a509dce6cff41726322a">GpioPin</a> <a class="el" href="structaudio__driver_1_1_pins_i2_c.html#a3e2bb798e2f223fbf471e1c2b634d803">scl</a>, <a class="el" href="namespaceaudio__driver.html#a4c343c4d8992a509dce6cff41726322a">GpioPin</a> <a class="el" href="structaudio__driver_1_1_pins_i2_c.html#ae3eace66d9648e8cb1d9c5c7a03f56a0">sda</a>, int <a class="el" href="structaudio__driver_1_1_pins_i2_c.html#a63c89c04d1feae07ca35558055155ffb">port</a>=-1, uint32_t <a class="el" href="structaudio__driver_1_1_pins_i2_c.html#ab632fb0b4d5156ea4df0b1e15410e913">frequency</a>=100000, TwoWire &amp;wire=Wire, bool active=true)</td></tr>
<tr class="separator:a64bff2ba6d0ee2ba3a79ff999af30243"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a601fb7cf1fc15db50c71a826f084f934"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__driver_1_1_pins_i2_c.html#a601fb7cf1fc15db50c71a826f084f934">begin</a> ()</td></tr>
<tr class="separator:a601fb7cf1fc15db50c71a826f084f934"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf81d3fdaf258088d7692fa70cece087"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__driver_1_1_pins_i2_c.html#aaf81d3fdaf258088d7692fa70cece087">end</a> ()</td></tr>
<tr class="separator:aaf81d3fdaf258088d7692fa70cece087"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b3baad8c612d81b96e46f84d7e97580"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__driver_1_1_pins_i2_c.html#a9b3baad8c612d81b96e46f84d7e97580">operator bool</a> ()</td></tr>
<tr class="separator:a9b3baad8c612d81b96e46f84d7e97580"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad52eccd1bc2d4dfdb82e132cd695898e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__driver_1_1_pins_i2_c.html#ad52eccd1bc2d4dfdb82e132cd695898e">pinsAvailable</a> ()</td></tr>
<tr class="separator:ad52eccd1bc2d4dfdb82e132cd695898e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab632fb0b4d5156ea4df0b1e15410e913"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__driver_1_1_pins_i2_c.html#ab632fb0b4d5156ea4df0b1e15410e913">frequency</a> = 100000</td></tr>
<tr class="separator:ab632fb0b4d5156ea4df0b1e15410e913"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada2a63b4baedf5b15ec9eaf1c575d208"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__audio__driver.html#ga6b03ddbf1e0f5abd0e46e02555850aaf">PinFunction</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__driver_1_1_pins_i2_c.html#ada2a63b4baedf5b15ec9eaf1c575d208">function</a></td></tr>
<tr class="separator:ada2a63b4baedf5b15ec9eaf1c575d208"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a682f8efbc92ac93c85e4f18798050bb7"><td class="memItemLeft" align="right" valign="top">TwoWire *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__driver_1_1_pins_i2_c.html#a682f8efbc92ac93c85e4f18798050bb7">p_wire</a> = &amp;Wire</td></tr>
<tr class="separator:a682f8efbc92ac93c85e4f18798050bb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63c89c04d1feae07ca35558055155ffb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__driver_1_1_pins_i2_c.html#a63c89c04d1feae07ca35558055155ffb">port</a> = -1</td></tr>
<tr class="separator:a63c89c04d1feae07ca35558055155ffb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e2bb798e2f223fbf471e1c2b634d803"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceaudio__driver.html#a4c343c4d8992a509dce6cff41726322a">GpioPin</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__driver_1_1_pins_i2_c.html#a3e2bb798e2f223fbf471e1c2b634d803">scl</a> = -1</td></tr>
<tr class="separator:a3e2bb798e2f223fbf471e1c2b634d803"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3eace66d9648e8cb1d9c5c7a03f56a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceaudio__driver.html#a4c343c4d8992a509dce6cff41726322a">GpioPin</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__driver_1_1_pins_i2_c.html#ae3eace66d9648e8cb1d9c5c7a03f56a0">sda</a> = -1</td></tr>
<tr class="separator:ae3eace66d9648e8cb1d9c5c7a03f56a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afcc542ba9c5c0e2fbba65a0feab74508"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structaudio__driver_1_1_pins_i2_c.html#afcc542ba9c5c0e2fbba65a0feab74508">set_active</a> = true</td></tr>
<tr class="separator:afcc542ba9c5c0e2fbba65a0feab74508"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>I2C pins. </p>
<dl class="section author"><dt>Author</dt><dd>Phil Schatzmann </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>GPLv3 </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a55ca58ba71e8274ece07c6455513ad8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55ca58ba71e8274ece07c6455513ad8e">&#9670;&nbsp;</a></span>PinsI2C() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structaudio__driver_1_1_pins_i2_c.html">PinsI2C</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a64bff2ba6d0ee2ba3a79ff999af30243"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64bff2ba6d0ee2ba3a79ff999af30243">&#9670;&nbsp;</a></span>PinsI2C() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structaudio__driver_1_1_pins_i2_c.html">PinsI2C</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__audio__driver.html#ga6b03ddbf1e0f5abd0e46e02555850aaf">PinFunction</a>&#160;</td>
          <td class="paramname"><em>function</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceaudio__driver.html#a4c343c4d8992a509dce6cff41726322a">GpioPin</a>&#160;</td>
          <td class="paramname"><em>scl</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceaudio__driver.html#a4c343c4d8992a509dce6cff41726322a">GpioPin</a>&#160;</td>
          <td class="paramname"><em>sda</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>port</em> = <code>-1</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>frequency</em> = <code>100000</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TwoWire &amp;&#160;</td>
          <td class="paramname"><em>wire</em> = <code>Wire</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>active</em> = <code>true</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a601fb7cf1fc15db50c71a826f084f934"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a601fb7cf1fc15db50c71a826f084f934">&#9670;&nbsp;</a></span>begin()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool begin </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="aaf81d3fdaf258088d7692fa70cece087"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf81d3fdaf258088d7692fa70cece087">&#9670;&nbsp;</a></span>end()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void end </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a9b3baad8c612d81b96e46f84d7e97580"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b3baad8c612d81b96e46f84d7e97580">&#9670;&nbsp;</a></span>operator bool()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">operator bool </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="ad52eccd1bc2d4dfdb82e132cd695898e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad52eccd1bc2d4dfdb82e132cd695898e">&#9670;&nbsp;</a></span>pinsAvailable()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool pinsAvailable </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ab632fb0b4d5156ea4df0b1e15410e913"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab632fb0b4d5156ea4df0b1e15410e913">&#9670;&nbsp;</a></span>frequency</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t frequency = 100000</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ada2a63b4baedf5b15ec9eaf1c575d208"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada2a63b4baedf5b15ec9eaf1c575d208">&#9670;&nbsp;</a></span>function</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__audio__driver.html#ga6b03ddbf1e0f5abd0e46e02555850aaf">PinFunction</a> function</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a682f8efbc92ac93c85e4f18798050bb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a682f8efbc92ac93c85e4f18798050bb7">&#9670;&nbsp;</a></span>p_wire</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TwoWire* p_wire = &amp;Wire</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a63c89c04d1feae07ca35558055155ffb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63c89c04d1feae07ca35558055155ffb">&#9670;&nbsp;</a></span>port</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int port = -1</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="a3e2bb798e2f223fbf471e1c2b634d803"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e2bb798e2f223fbf471e1c2b634d803">&#9670;&nbsp;</a></span>scl</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceaudio__driver.html#a4c343c4d8992a509dce6cff41726322a">GpioPin</a> scl = -1</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ae3eace66d9648e8cb1d9c5c7a03f56a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3eace66d9648e8cb1d9c5c7a03f56a0">&#9670;&nbsp;</a></span>sda</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceaudio__driver.html#a4c343c4d8992a509dce6cff41726322a">GpioPin</a> sda = -1</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="afcc542ba9c5c0e2fbba65a0feab74508"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afcc542ba9c5c0e2fbba65a0feab74508">&#9670;&nbsp;</a></span>set_active</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool set_active = true</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/<a class="el" href="_driver_pins_8h_source.html">DriverPins.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
